feat(nextjs,backend,integration): Introduce dynamic keys from `clerkMiddleware` by LauraBeatris · Pull Request #3525 · clerk/javascript

LauraBeatris · 2024-06-05T20:51:02Z

Description

Resolves SDK-1253, SDK-1811, SDK-1770

This PR introduces dynamic keys from clerkMiddleware, solving the following problems:

auth() cannot assert the session token signature due to an undefined secret key, leading to a runtime error.
auth.createRedirect doesn't redirect to signInUrl or signUpUrl since those aren't propagated as well.

The propagation is done by encrypting an x-clerk-request-data header and sending it from the middleware runtime to the application runtime, where it's going to be decrypted using a key. The key used for encryption is resolved based on the following conditions:

If security-sensitive options, such as secretKey are provided, then CLERK_ENCRYPTION_KEY is required
Otherwise, fallbacks to CLERK_SECRET_KEY, which is going to have backward compatibility.

Checklist

npm test runs as expected.
npm run build runs as expected.
(If applicable) JSDoc comments have been added or updated for any package exports
(If applicable) Documentation has been updated
- Merge Docs PR with this PR

Type of change

changeset-bot · 2024-06-05T20:51:06Z

🦋 Changeset detected

Latest commit: c458ab7

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 7 packages

Name	Type
@clerk/backend	Minor
@clerk/nextjs	Minor
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/remix	Patch
@clerk/clerk-sdk-node	Patch
@clerk/tanstack-start	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

nikosdouvlis · 2024-06-10T11:48:16Z

I know that this is still a draft PR, so don't worry about this comment yet. Once everything's is in place, let's also add an e2e test covering this flow. Feel free to ping anyone from team-sdk about this :)

…runtime (#3617)

dimkl · 2024-07-02T10:29:30Z

❓ Why did we choose the approach of the clerkClient() Proxy instead of exposing a getClerkClient()?
Even though we have already introduced the Proxy in the @clerk/clerk-sdk-node to load dynamically the env variables, I think that we could avoid using it here, and introduce a more specific API to avoid any confusion over the clerkClient.

cc: @LauraBeatris , @nikosdouvlis , @brkalow

LauraBeatris self-assigned this Jun 5, 2024

clerk-cookie added the nextjs label Jun 5, 2024

LauraBeatris changed the title ~~feat(clerk-nextjs): Propagate clerkMiddleware options to application server~~ feat(nextjs): Propagate clerkMiddleware options to application server Jun 5, 2024

LauraBeatris force-pushed the propagate-nextjs-middleware-options branch from 4dd4f25 to 31cd84c Compare June 5, 2024 20:59

clerk-cookie added the backend label Jun 5, 2024

LauraBeatris force-pushed the propagate-nextjs-middleware-options branch 4 times, most recently from ecf05b8 to daf8b1c Compare June 7, 2024 17:15

LauraBeatris commented Jun 7, 2024

View reviewed changes

Comment thread packages/nextjs/src/app-router/server/ClerkProvider.tsx Outdated

nikosdouvlis reviewed Jun 10, 2024

View reviewed changes

Comment thread packages/nextjs/src/app-router/server/ClerkProvider.tsx Outdated

Comment thread packages/nextjs/src/app-router/server/auth.ts Outdated

Comment thread packages/nextjs/src/server/errors.ts Outdated

Comment thread packages/nextjs/src/server/utils.ts

brkalow reviewed Jun 10, 2024

View reviewed changes

Comment thread packages/nextjs/src/app-router/server/ClerkProvider.tsx Outdated

Comment thread packages/nextjs/src/server/clerkMiddleware.ts Outdated

Comment thread packages/nextjs/src/server/utils.ts Outdated

This was referenced Jun 11, 2024

Add signUpUrl option from clerkMiddleware clerk/clerk-docs#1153

Merged

Add missing signUpUrl property from ClerkProvider clerk/clerk-docs#1154

Merged

clerk-cookie added the playground label Jun 12, 2024

LauraBeatris force-pushed the propagate-nextjs-middleware-options branch 2 times, most recently from c3f1524 to 27ba688 Compare June 12, 2024 17:39

clerk-cookie removed the playground label Jun 12, 2024

LauraBeatris force-pushed the propagate-nextjs-middleware-options branch 2 times, most recently from c782f11 to 4c4ee19 Compare June 12, 2024 19:40

clerk-cookie added the playground label Jun 12, 2024

LauraBeatris force-pushed the propagate-nextjs-middleware-options branch 3 times, most recently from 9ba87be to 99893b4 Compare June 12, 2024 19:45

clerk-cookie removed the playground label Jun 12, 2024

LauraBeatris force-pushed the propagate-nextjs-middleware-options branch 2 times, most recently from fffc077 to 220cff9 Compare June 13, 2024 16:13

clerk-cookie added the integration label Jun 13, 2024

LauraBeatris added 25 commits July 1, 2024 18:44

Introduce fallback for encryption key

d02913e

Implement test case for signInUrl option

3e5758b

Add CLERK_ENCRYPTION_KEY to integration tests

919ec6e

Access redirect URLs from middleware options

73942bd

Add changeset

853d90e

Mock ENCRYPTION_KEY on authMiddleware unit tests

c1856cb

Update snapshot for request headers

0be0727

Warn when encryption key is missing instead of throwing

f520025

Reference to docs on error message and changeset

8059461

Add todo comment for next major version

4deca28

Propagate secret key to backend client

aa532db

Update changeset

7109105

Propagate publishableKey to auth

6ee667b

Update changeset to mention Dynamic Keys

b618edf

Update encryption key env var for integration tests

d8cc06e

Add CLERK_ENCRYPTION_KEY to CI

7d462a6

feat(nextjs): Read dynamic keys from clerkClient within middleware …

f7df0ee

…runtime (#3617)

Rollback changes on authMiddleware

f3d83c8

Fix unit tests and Proxy

25eaaf2

Mention clerkClient on changeset

e2b4078

Fallback to ALS on headers error

89a8a4c

Update changeset

b76e2bb

Fix error formatting

ed3aa79

Extract middleware handler to separate variable

7170e31

Re-throw errors related to static generation bail-out

db5fc1e

LauraBeatris force-pushed the propagate-nextjs-middleware-options branch from 20adf12 to a9c0509 Compare July 1, 2024 21:44

Remove @clerk/shared from changeset

c458ab7

LauraBeatris force-pushed the propagate-nextjs-middleware-options branch from a9c0509 to c458ab7 Compare July 1, 2024 22:08

clerk-cookie mentioned this pull request Jul 1, 2024

ci(repo): Version packages #3631

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(nextjs,backend,integration): Introduce dynamic keys from `clerkMiddleware` - #3525

feat(nextjs,backend,integration): Introduce dynamic keys from `clerkMiddleware` #3525
LauraBeatris merged 39 commits into
mainfrom
propagate-nextjs-middleware-options

LauraBeatris commented Jun 5, 2024 •

edited

Loading

Uh oh!

changeset-bot Bot commented Jun 5, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nikosdouvlis commented Jun 10, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dimkl commented Jul 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

LauraBeatris commented Jun 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Type of change

Uh oh!

changeset-bot Bot commented Jun 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nikosdouvlis commented Jun 10, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dimkl commented Jul 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

LauraBeatris commented Jun 5, 2024 •

edited

Loading

changeset-bot Bot commented Jun 5, 2024 •

edited

Loading